Enhance LogRecord::add_attributes interface to accept generic Iterables #1741
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1741 +/- ##
=======================================
+ Coverage 71.0% 71.4% +0.3%
=======================================
Files 135 136 +1
Lines 20751 20880 +129
=======================================
+ Hits 14746 14915 +169
+ Misses 6005 5965 -40 ☔ View full report in Codecov by Sentry. |
lalitb
commented
May 11, 2024
| where | ||
| I: IntoIterator<Item = (K, V)>, | ||
| K: Into<Key>, | ||
| V: Into<AnyValue>; |
There was a problem hiding this comment.
Not adding the default implementation to iteratively call add_attribute in API, let SDK decide how to add the attributes.
TommyCpp
approved these changes
May 11, 2024
cijothomas
reviewed
May 11, 2024
| @@ -26,7 +26,11 @@ pub trait LogRecord { | |||
| fn set_body(&mut self, body: AnyValue); | |||
|
|
|||
| /// Adds multiple attributes. | |||
| fn add_attributes(&mut self, attributes: Vec<(Key, AnyValue)>); | |||
| fn add_attributes<I, K, V>(&mut self, attributes: I) | |||
There was a problem hiding this comment.
would be good to leave a comment explaining that this API is designed to take ownership, unlike Metric APIs which just need slice/ref only to attributes.
cijothomas
approved these changes
May 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Modify the
add_attributesmethod in theLogRecordtrait to accept any type that implementsIntoIterator, for better flexibility and usability. This change allows the method to handle a wider range of input types, including arrays, vectors, hashmap, and other custom collections.Existing:
PR:
Merge requirement checklist
CHANGELOG.mdfiles updated for non-trivial, user-facing changes